Skip to content

Add three new vignettes to expand the vignette library#440

Closed
ishaan-arora-1 wants to merge 1 commit intostan-dev:masterfrom
ishaan-arora-1:docs/expand-vignette-library-436
Closed

Add three new vignettes to expand the vignette library#440
ishaan-arora-1 wants to merge 1 commit intostan-dev:masterfrom
ishaan-arora-1:docs/expand-vignette-library-436

Conversation

@ishaan-arora-1
Copy link
Contributor

@ishaan-arora-1 ishaan-arora-1 commented Mar 10, 2026 •
edited
Loading

Summary

Addresses #436 by adding three new vignettes to improve discoverability and onboarding:

Also related to #144 (extend vignettes) and #142 (contributor template vignette).

AI Usage Policy :
Major portion of this documentation was generated using an LLM.

@ishaan-arora-1
Add three new vignettes for expanded documentation (stan-dev#436)
46d24b0 
- "Which plot should I use?" -- lookup table mapping diagnostic
  questions to recommended functions
- "Bayesplot and the Bayesian workflow" -- end-to-end modeling
  example covering all workflow stages
- "Customizing bayesplot outputs" -- guide to modifying plots
  via ggplot2, color schemes, themes, and helper functions

Closes stan-dev#436
@florence-bockting
Copy link

florence-bockting commented Mar 13, 2026

Thanks, @ishaan-arora-1, for the PR. I really appreciate your enthusiasm for tackling these problems. I realized my original issue description might not have been clear enough regarding its status. Before we dive into the solution, I think we should discuss a few things to make sure we're on the right track:

  • Which vignettes do we want to have?
  • What should be the content of each?
  • What should be the relation between the vignettes?
  • Do we want to have one long vignette or rather smaller, more focused vignettes?
  • Etc.

So, there is some uncertainty here and we should first agree on a path that we want to go. Good ideas to move forward is for example to do first some research on resources about "How to write good documentation" and then we need to start thinking about the "structure/content of vignettes and relation between vignettes" such that they are most useful from the perspective of the user.

@jgabry would you agree?

(Additionally, the same hint I mentioned in PR#439, regarding rendering vignettes locally, applies to this PR as well.)

@ishaan-arora-1
Copy link
Contributor Author

ishaan-arora-1 commented Mar 13, 2026

Thanks, @ishaan-arora-1, for the PR. I really appreciate your enthusiasm for tackling these problems. I realized my original issue description might not have been clear enough regarding its status. Before we dive into the solution, I think we should discuss a few things to make sure we're on the right track:

  • Which vignettes do we want to have?
  • What should be the content of each?
  • What should be the relation between the vignettes?
  • Do we want to have one long vignette or rather smaller, more focused vignettes?
  • Etc.

So, there is some uncertainty here and we should first agree on a path that we want to go. Good ideas to move forward is for example to do first some research on resources about "How to write good documentation" and then we need to start thinking about the "structure/content of vignettes and relation between vignettes" such that they are most useful from the perspective of the user.

@jgabry would you agree?

(Additionally, the same hint I mentioned in PR#439, regarding rendering vignettes locally, applies to this PR as well.)

Youre absolutely right @florence-bockting
I'll close this PR for now. Happy to contribute to the discussion on what vignettes would be most useful and how they should be organized, before implementing a solution to this.

@jgabry
Copy link
Member

jgabry commented Mar 13, 2026

Thanks to you both, I agree

@ishaan-arora-1 ishaan-arora-1 mentioned this pull request Mar 14, 2026
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@ishaan-arora-1 @florence-bockting @jgabry